All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.html.HTMLEditorKit 

java.lang.Object
   |
   +----com.sun.java.swing.text.EditorKit
           |
           +----com.sun.java.swing.text.DefaultEditorKit
                   |
                   +----com.sun.java.swing.text.StyledEditorKit
                           |
                           +----com.sun.java.swing.text.html.HTMLEditorKit
public class HTMLEditorKit
extends StyledEditorKit
This is the default implementation of html editing functionality. The primary goal with this is to be small, but flexible. It is not intended to be an all singing and all dancing html implementation. This is provided to meet more modest needs, with the idea that more substantial needs can be met with alternative implementations.

Variable Index

o BOLD_ACTION
The bold action identifier
o COLOR_ACTION
The Color choice action identifier The color is passed as an argument
o DEFAULT_CSS
Default Cascading Style Sheet file that sets up the tag views.
o FONT_CHANGE_BIGGER
The font size increase to next value action identifier
o FONT_CHANGE_SMALLER
The font size decrease to next value action identifier
o IMG_ALIGN_BOTTOM
Align images at the bottom.
o IMG_ALIGN_MIDDLE
Align images in the middle.
o IMG_ALIGN_TOP
Align images at the top.
o IMG_BORDER
Align images at the border.
o ITALIC_ACTION
The italic action identifier
o LOGICAL_STYLE_ACTION
The logical style choice action identifier The logical style is passed in as an argument
o PARA_INDENT_LEFT
The paragraph left indent action identifier
o PARA_INDENT_RIGHT
The paragraph right indent action identifier

Constructor Index

o HTMLEditorKit()
Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet.

Method Index

o clone()
Create a copy of the editor kit.
o createDefaultDocument()
Create an uninitialized text storage model that is appropriate for this type of editor.
o deinstall(JEditorPane)
Called when the kit is being removed from the JEditorPane.
o getActions()
Fetches the command list for the editor.
o getContentType()
Get the MIME type of the data that this kit represents support for.
o getParser()
Fetch the parser to use for reading html streams.
o getViewFactory()
Fetch a factory that is suitable for producing views of any models that are produced by this kit.
o install(JEditorPane)
Called when the kit is being installed into the a JEditorPane.
o read(Reader, Document, int)
Create and initialize a model from the given stream which is expected to be in a format appropriate for this kind of editor.
o write(Writer, Document, int, int)
Write content from a document to the given stream in a format appropriate for this kind of content handler.

Variables

o DEFAULT_CSS 
 public static final String DEFAULT_CSS
Default Cascading Style Sheet file that sets up the tag views.

o BOLD_ACTION 
 public static final String BOLD_ACTION
The bold action identifier

o ITALIC_ACTION 
 public static final String ITALIC_ACTION
The italic action identifier

o PARA_INDENT_LEFT 
 public static final String PARA_INDENT_LEFT
The paragraph left indent action identifier

o PARA_INDENT_RIGHT 
 public static final String PARA_INDENT_RIGHT
The paragraph right indent action identifier

o FONT_CHANGE_BIGGER 
 public static final String FONT_CHANGE_BIGGER
The font size increase to next value action identifier

o FONT_CHANGE_SMALLER 
 public static final String FONT_CHANGE_SMALLER
The font size decrease to next value action identifier

o COLOR_ACTION 
 public static final String COLOR_ACTION
The Color choice action identifier The color is passed as an argument

o LOGICAL_STYLE_ACTION 
 public static final String LOGICAL_STYLE_ACTION
The logical style choice action identifier The logical style is passed in as an argument

o IMG_ALIGN_TOP 
 public static final String IMG_ALIGN_TOP
Align images at the top.

o IMG_ALIGN_MIDDLE 
 public static final String IMG_ALIGN_MIDDLE
Align images in the middle.

o IMG_ALIGN_BOTTOM 
 public static final String IMG_ALIGN_BOTTOM
Align images at the bottom.

o IMG_BORDER 
 public static final String IMG_BORDER
Align images at the border.

Constructors

o HTMLEditorKit 
 public HTMLEditorKit()
Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet.

Methods

o clone 
 public Object clone()
Create a copy of the editor kit. This allows an implementation to serve as a prototype for others, so that they can be quickly created.

Returns:
the copy
Overrides:
clone in class StyledEditorKit
o getContentType 
 public String getContentType()
Get the MIME type of the data that this kit represents support for. This kit supports the type text/html.

Returns:
the type
Overrides:
getContentType in class DefaultEditorKit
o getViewFactory 
 public ViewFactory getViewFactory()
Fetch a factory that is suitable for producing views of any models that are produced by this kit.

Returns:
the factory
Overrides:
getViewFactory in class StyledEditorKit
o createDefaultDocument 
 public Document createDefaultDocument()
Create an uninitialized text storage model that is appropriate for this type of editor.

Returns:
the model
Overrides:
createDefaultDocument in class StyledEditorKit
o read 
 public void read(Reader in,
                  Document doc,
                  int pos) throws IOException, BadLocationException
Create and initialize a model from the given stream which is expected to be in a format appropriate for this kind of editor. This is implemented to read html 3.2 text.

Parameters:
in - The stream to read from
doc - The destination for the insertion.
pos - The location in the document to place the content.
Throws: IOException
on any I/O error
Throws: BadLocationException
if pos represents an invalid location within the document.
Overrides:
read in class DefaultEditorKit
o write 
 public void write(Writer out,
                   Document doc,
                   int pos,
                   int len) throws IOException, BadLocationException
Write content from a document to the given stream in a format appropriate for this kind of content handler.

Parameters:
out - The stream to write to
doc - The source for the write.
pos - The location in the document to fetch the content.
len - The amount to write out.
Throws: IOException
on any I/O error
Throws: BadLocationException
if pos represents an invalid location within the document.
Overrides:
write in class DefaultEditorKit
o install 
 public void install(JEditorPane c)
Called when the kit is being installed into the a JEditorPane.

Parameters:
c - the JEditorPane
Overrides:
install in class StyledEditorKit
o deinstall 
 public void deinstall(JEditorPane c)
Called when the kit is being removed from the JEditorPane. This is used to unregister any listeners that were attached.

Parameters:
c - the JEditorPane
Overrides:
deinstall in class StyledEditorKit
o getActions 
 public Action[] getActions()
Fetches the command list for the editor. This is the list of commands supported by the superclass augmented by the collection of commands defined locally for style operations.

Returns:
the command list
Overrides:
getActions in class StyledEditorKit
o getParser 
 protected HTMLEditorKit. Parser getParser()
Fetch the parser to use for reading html streams. This can be reimplemented to provide a different parser. The default implementation is loaded dynamically to avoid the overhead of loading the default parser if it's not used. The default parser is based upon JavaCC, with the grammar defined in the file html-3.2.jj. One can replace the parser using a customized grammar, or replace the parser with one that doesn't use the JavaCC parser generator. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index